ReadMe Template, for the heck of it.
The Elder Scrolls Homepage | HelpSearchMembersCalendar |
Logged in as: OldeCow69 ( Log Out ) | My Controls · View New Posts · My Assistant · 0 New Messages |
ReadMe Template, for the heck of it.
GlassBoy |
Sep 7 2004, 06:53 AM
Post
#1
|
Disciple Joined: 11-August 02 |
Hey all, this is not really a mod at all, but I thought of it, and figured, "Hey, why not?"
This is a simple template for anyone to use whenever they make a readme file for their mods. It has stuff typed out and ready for additions, depending on the mod. The reason I did this is just to remove a minor nuisance by reducing the typing you need to make a nice readme file for your mods. Here it is: ============================================== MOD NAME---> VERSION----> CREATED BY-> ============================================== INDEX: -> Requirements -> About this mod -> Installation -> Files and their Proper Directories -> Playing this plugin -> Known Bugs & Issues -> Version History -> Incompatibilities & Save game warnings -> Credits & Usage ============================================== REQUIREMENTS: ============================================== REQUIRES Bloodmoon? -> REQUIRES Tribunal? -> Mods Needed to run this plugin? -> ============================================== ABOUT THIS MOD: =============================================== =============================================== INSTALLATION: =============================================== Extract all .esp and .esm files to the Data Files directory. Extract all .nif Files to the Data Files\Meshes directory. =============================================== FILES USED AND THEIR PROPER DIRECTORIES: =============================================== ~~~~~~~~~~~README FILE~~~~~~~~~~~~~~ ~~~~~~~~~ESP & ESM FILES~~~~~~~~~~~~ \Data Files\ \Data Files\ ~~~~~~~~~~~~~~MESHES~~~~~~~~~~~~~~~~ \Data Files\Meshes\ \Data Files\Meshes\ \Data Files\Meshes\ ~~~~~~~~~~~~~TEXTURES~~~~~~~~~~~~~~~ \Data Files\Textures\ \Data Files\Textures\ \Data Files\Textures\ ~~~~~~~~~~~~~~ICONS~~~~~~~~~~~~~~~~~ \Data Files\Icons\ \Data Files\Icons\ \Data Files\Icons\ ~~~~~~~~~~~~~~MUSIC~~~~~~~~~~~~~~~~~ \Data Files\Music\ \Data Files\Music\ ~~~~~~~~~~~~~~SOUND~~~~~~~~~~~~~~~~~ \Data Files\Sound\ \Data Files\Sound\ =============================================== PLAYING THIS PLUGIN: =============================================== =============================================== KNOWN ISSUES OR BUGS: =============================================== =============================================== VERSION HISTORY =============================================== =============================================== INCOMPATIBILITIES & SAVED GAME WARNINGS: =============================================== Always make sure that you backup your existing savegame before use. =============================================== CREDITS & USAGE: =============================================== ( Template user: Pick one and delete the rest) --> Feel Free to use any of the resources I provided in this plugin, but give credit to me where it is due. --> You may use any of the resources I provided in this mod, but please contact me first by email for permission. --> Please don't use any of the resources in this plugin. EMAIL: And that's the end of the readme template, hope it's handy to you guys and gals. -------------------- |
Valdimathor |
Sep 7 2004, 07:01 AM
Post
#2
|
Disciple Joined: 2-July 03 From: Czech Republic |
There is loooot of people who should have read this one.
Sad but true. Deserves a sticky. -------------------- Warlock, in the service of Syrabane.
I don't recall using teleportation, and yet there I was. Alone. Naked. |
btodd |
Sep 7 2004, 07:02 AM
Post
#3
|
Novice Joined: 27-August 03 From: Dallas, TX |
Wow that is a really good idea!
-------------------- Maybe, just maybe, my boys could stop them from gettin' the book. Yeah, and maybe I'm a chinese jet pilot.
|
Iudas |
Sep 7 2004, 07:09 AM
Post
#4
|
Diviner Joined: 31-October 02 |
QUOTE(GlassBoy @ Sep 6 2004, 05:13 PM) Hey all, this is not really a mod at all, but I thought of it, and figured, "Hey, why not?" This is a simple template for anyone to use whenever they make a readme file for their mods. It has stuff typed out and ready for additions, depending on the mod. The reason I did this is just to remove a minor nuisance by reducing the typing you need to make a nice readme file for your mods. Here it is: ============================================== MOD NAME---> VERSION----> CREATED BY-> ============================================== INDEX: -> Requirements -> About this mod -> Installation -> Files and their Proper Directories -> Playing this plugin -> Known Bugs & Issues -> Version History -> Incompatibilities & Save game warnings -> Credits & Usage ============================================== REQUIREMENTS: ============================================== REQUIRES Bloodmoon? -> REQUIRES Tribunal? -> Mods Needed to run this plugin? -> ============================================== ABOUT THIS MOD: =============================================== =============================================== INSTALLATION: =============================================== Extract all .esp and .esm files to the Data Files directory. Extract all .nif Files to the Data Files\Meshes directory. =============================================== FILES USED AND THEIR PROPER DIRECTORIES: =============================================== ~~~~~~~~~~~README FILE~~~~~~~~~~~~~~ ~~~~~~~~~ESP & ESM FILES~~~~~~~~~~~~ \Data Files\ \Data Files\ ~~~~~~~~~~~~~~MESHES~~~~~~~~~~~~~~~~ \Data Files\Meshes\ \Data Files\Meshes\ \Data Files\Meshes\ ~~~~~~~~~~~~~TEXTURES~~~~~~~~~~~~~~~ \Data Files\Textures\ \Data Files\Textures\ \Data Files\Textures\ ~~~~~~~~~~~~~~ICONS~~~~~~~~~~~~~~~~~ \Data Files\Icons\ \Data Files\Icons\ \Data Files\Icons\ ~~~~~~~~~~~~~~MUSIC~~~~~~~~~~~~~~~~~ \Data Files\Music\ \Data Files\Music\ ~~~~~~~~~~~~~~SOUND~~~~~~~~~~~~~~~~~ \Data Files\Sound\ \Data Files\Sound\ =============================================== PLAYING THIS PLUGIN: =============================================== =============================================== KNOWN ISSUES OR BUGS: =============================================== =============================================== VERSION HISTORY =============================================== =============================================== INCOMPATIBILITIES & SAVED GAME WARNINGS: =============================================== Always make sure that you backup your existing savegame before use. =============================================== CREDITS & USAGE: =============================================== ( Template user: Pick one and delete the rest) --> Feel Free to use any of the resources I provided in this plugin, but give credit to me where it is due. --> You may use any of the resources I provided in this mod, but please contact me first by email for permission. --> Please don't use any of the resources in this plugin. EMAIL: And that's the end of the readme template, hope it's handy to you guys and gals. I would like to add just one suggestion to this, Name the file something other than ReadMe.txt....ReadMe-MYMODNAME.txt would be fine or MYMODNAME-ReadME.txt. We try to make sure our mods don't walk all over other people's work, probably a good idea for our ReadMe file was as well behaved. |
baratheon79 |
Sep 7 2004, 07:23 AM
Post
#5
|
Diviner Joined: 26-May 03 |
Nice idea for those people out there who are relatively new to modding, and who don't know how to write up a proper readme. I myself have a basic template stored on another of my computers that I use, which includes most of your template does, except for the list of files (I make the assumption that anyone who is going to use the mod has enough working brain cells to understand how to extract the mod directly into the Data Files folder ).
This post has been edited by baratheon79: Sep 7 2004, 07:24 AM -------------------- |
dreamcrafter |
Sep 7 2004, 07:28 AM
Post
#6
|
Acolyte Joined: 2-September 04 From: Ursa Minor Beta |
I have to agree with my fellow modders, this is one nifty thing you came up with. mad props!!
-------------------- |
Ronin49 |
Sep 7 2004, 07:33 AM
Post
#7
|
Diviner Joined: 9-March 04 From: Midgard |
Thanks, Glassboy. This is most welcome and hopefully will be used by those who could most benefit from it. And I find the list of files very useful sometimes: would suggest to leave it in - 'best practice' etc.
-------------------- |
GlassBoy |
Sep 7 2004, 09:14 AM
Post
#8
|
Disciple Joined: 11-August 02 |
QUOTE(baratheon79 @ Sep 6 2004, 05:43 PM) Nice idea for those people out there who are relatively new to modding, and who don't know how to write up a proper readme. I myself have a basic template stored on another of my computers that I use, which includes most of your template does, except for the list of files (I make the assumption that anyone who is going to use the mod has enough working brain cells to understand how to extract the mod directly into the Data Files folder ). Thanks. The reason for the list of files used is so that a person can easily uninstall or remove a mod that (s)he's tired of. Or remove components of a mod for alternate updated components. Or use your more preferred plugin over another. Because some people just put all the meshes under A, M, or C etc. instead of their own folder under those files with the name of the mod. -------------------- |
Mode_Locrian |
Sep 7 2004, 09:19 AM
Post
#9
|
Diviner Joined: 8-October 02 From: Bjornholm, Rykith Lowlands Region |
Nice. I've got my own template (similar to that) that I use for my readme files (I've started making them as HTML docs instead, so I can put links and stuff in them), but this is definitely a time-saving resource.
-------------------- |
Polycrates |
Sep 7 2004, 09:37 AM
Post
#10
|
Curate Joined: 17-June 03 |
Really good thinking.
Though if you're going for 'best practice' with including all files used in the readme, maybe also a list of all cells altered, to give people an idea of what it's going to be incompatible with. But yeah, excellent idea and one that's very needed (have you seen how many mods at the Summit don't even include a readme at all?). Kudos! -------------------- |
GlassBoy |
Sep 7 2004, 12:47 PM
Post
#11
|
Disciple Joined: 11-August 02 |
Thanks guys, i kind of wish there was a way to keep this readily readable. I guess it could use a sticky?
-------------------- |
Ronin49 |
Sep 7 2004, 12:57 PM
Post
#12
|
Diviner Joined: 9-March 04 From: Midgard |
QUOTE(GlassBoy @ Sep 6 2004, 11:07 PM) Thanks guys, i kind of wish there was a way to keep this readily readable. I guess it could use a sticky? I will pick it up on a list and then put it into the currently empty Tool Box at Mythic Mods website when we start to fill it up, how's that? Sticky is a good idea too . . . -------------------- |
GlassBoy |
Sep 7 2004, 02:17 PM
Post
#13
|
Disciple Joined: 11-August 02 |
QUOTE(Ronin49 @ Sep 6 2004, 11:17 PM) I will pick it up on a list and then put it into the currently empty Tool Box at Mythic Mods website when we start to fill it up, how's that? Sticky is a good idea too . . . Cool, that's a start. thanks -------------------- |
DMKW |
Sep 7 2004, 02:44 PM
Post
#14
|
Diviner Joined: 28-August 02 From: Ontario, Canada |
hey great idea! i'm bookmarking this
-------------------- |
GlassBoy |
Sep 10 2004, 02:17 PM
Post
#15
|
Disciple Joined: 11-August 02 |
A bump for new readers.
-------------------- |
Ronin49 |
Oct 7 2004, 11:33 PM
Post
#16
|
Diviner Joined: 9-March 04 From: Midgard |
Back to the top and out of oblivion. A good template.
-------------------- |
ReflectioN |
Oct 8 2004, 12:40 AM
Post
#17
|
Curate Joined: 11-September 03 From: The Netherlands |
Good idea Glassboy!
-------------------- Visit my website at http://freewebs.com/reflection_nl/ for info and screenshots of my mods:
Castle Vianden Créhange Manor Chainmail Armor Merchant Wooden Armor Mannequins Resource Fresco Pack Imperial Castle Retexture Packs; White and Vianden Style |
Ronin49 |
Oct 12 2004, 11:07 AM
Post
#18
|
Diviner Joined: 9-March 04 From: Midgard |
QUOTE I will pick it up on a list and then put it into the currently empty Tool Box at Mythic Mods website when we start to fill it up, how's that? Sticky is a good idea too . . . QUOTE(GlassBoy @ Sep 7 2004, 12:37 AM) Cool, that's a start. thanks OK - it is up: http://www.mwmythicmods.com/readme_gboy.html ToolBox isn't, so I will link it up in the Lists and Links on next revise. -------------------- |
efin |
Oct 12 2004, 11:40 AM
Post
#19
|
Disciple Joined: 24-May 04 From: Concord, NH |
Brilliant idea! And Iudas' idea is also great. I can't tell you how annoying it can be to sift through readmes only to find that the one you're looking for was overwritten...
-------------------- The old pool shooter had won many a game in his life. But now it was time to hang up the cue. When he did, all the other cues came crashing to the floor. "Sorry," he said with a smile. -Jack Handy- R |
DragoonWraith |
Oct 12 2004, 11:59 AM
Post
#20
|
Diviner Joined: 14-June 03 |
General thanks! Great idea, must-read for all would-be modders.
-------------------- "change the world..."
Total Oblivion Blinding light, bind my foes in unbreakable chains... Disperse the shadows! Ray of Paralysis!" ~Saradin Carm Bonus Points: Ronin +5 NuclearDope +10 MOO_COW +20 RavynAngel +20 Case +50 |
Pendraia |
Oct 12 2004, 06:24 PM
Post
#21
|
Adept Joined: 31-January 04 |
|
Ronin49 |
Feb 24 2005, 12:00 PM
Post
#22
|
Diviner Joined: 9-March 04 From: Midgard |
Glassboy - I suggest the Credits & Usage Section could usefully be changed a little to include (changes highlighted):
QUOTE =============================================== CREDITS & USAGE: =============================================== ( Template user: Pick one and delete the rest) --> Feel Free to use any of the resources I provided in this plugin, but give credit to me where it is due. --> You may use any of the resources I provided in this mod, but please contact me first by email for permission. --> Please don't use any of the resources in this plugin. ( Template user: Pick one and delete the rest) --> Feel free to redistribute, including upload to public download sites, without further reference to the author. You have my permission. --> Please contact me first by email for permission if you wish to upload or host this mod on a download site. --> Please do not redistribute to other download sites. EMAIL: WEBSITE: -------------------- |
Spot1st |
Feb 24 2005, 12:17 PM
Post
#23
|
Acolyte Joined: 12-February 05 From: Luar'kgen vaults |
QUOTE Deserves a sticky. Agreeed. -------------------- It was upon us atlast. Quick and as cold as the icest peaks of the laur'kgen mountains. I can still remember the screams of the men, unaware that they where the fortunate, unaware that to survive would mean... These where dark times, trully dark times.
|
Marbred |
Feb 24 2005, 01:23 PM
Post
#24
|
Curate Joined: 21-March 04 From: Paper st. |
Will do.
I agree with the sticky idea, and the ReadMe_ModName, etc. I hate read me files called just that- "Readme.txt" -------------------- Take a moment and release/look for mods in the
Morrowind Mods Release Forum MW Mog Forums |
blake. |
Today, 03:30 AM
Post
#25
|
Curate Joined: 20-June 04 |
great resource.
-------------------- |
Lo-Fi Version | 0.2399sec
0.48
9 queries
GZIP Enabled
Time is now: 28th February 2005 - 02:45 PM |
|